03 March 2025

REST Services Changes for 4.31

The following changes have been made to REST Services for 4.31:

Users can now send REST Service requests directly from the ebs REST Documentation using the Try it out functionality.

Try it out button

Refer to Use the Try It Out Functionality for further information.

An API has been added to ebs REST documentation that provides a health status summary of an ebs instance.

The endpoint for this REST service is described in the following table.

REST Service URL Verb
GetStatusCheck <web services URL>/System/Status GET

'HasOnlineContent' has been added to the following REST services:

  • Create Unit Instance

  • Update Unit Instance

  • Update Unit Instance Occurrence

    Refer to Curriculum Changes for 4.31 for further information on the new Has Online Content field.

NI The following changes have been made to CDR REST services:

  • The SLDD field has been removed from Create and Update web services for People
  • The SLDD field has been added to Create and Update web services for Enrolments
  • The InitialEmploymentStatus field has been added to Create and Update web services for People
  • The PriorEducationAchievement field has been added to Create and Update web services for People
  • The LevelOfQualification field has been added to Create and Update web services for People
  • The PoliticalOpinion field has been added to Create and Update web services for People
  • The Hasnodependants field is added to Create and Update web services for People